home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / ifl / TIFFSetField.z / TIFFSetField
Encoding:
Text File  |  2002-10-03  |  10.8 KB  |  197 lines

  1.  
  2.  
  3.  
  4. TTTTIIIIFFFFFFFFSSSSeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   TTTTIIIIFFFFFFFFSSSSeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      TIFFSetField - set the value(s) of a tag in a TIFF file open for writing
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ttttiiiiffffffffiiiioooo....hhhh>>>>
  13.      iiiinnnntttt TTTTIIIIFFFFFFFFSSSSeeeettttFFFFiiiieeeelllldddd((((TTTTIIIIFFFFFFFF**** ttttiiiiffff,,,, ttttttttaaaagggg____tttt ttttaaaagggg,,,, ............))))
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssttttddddaaaarrrrgggg....hhhh>>>>
  15.      iiiinnnntttt TTTTIIIIFFFFFFFFVVVVSSSSeeeettttFFFFiiiieeeelllldddd((((TTTTIIIIFFFFFFFF**** ttttiiiiffff,,,, ttttttttaaaagggg____tttt ttttaaaagggg,,,, vvvvaaaa____lllliiiisssstttt aaaapppp))))
  16.  
  17. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      _T_I_F_F_S_e_t_F_i_e_l_d sets the value of a field or pseudo-tag in the current
  19.      directory associated with the open TIFF file _t_i_f.  (A _p_s_e_u_d_o-_t_a_g is a
  20.      parameter that is used to control the operation of the TIFF library but
  21.      whose value is not read or written to the underlying file.)  The file
  22.      must have been previously opened for writing with _T_I_F_F_O_p_e_n(3T).  The
  23.      field is identified by _t_a_g, one of the values defined in the include file
  24.      ttttiiiiffffffff....hhhh (see also the table below).  The actual value is specified using a
  25.      variable argument list, as prescribed by the _s_t_d_a_r_g(3) interface (or, on
  26.      some machines, the _v_a_r_a_r_g_s(3) interface.)
  27.  
  28.      _T_I_F_F_V_S_e_t_F_i_e_l_d is functionally equivalent to _T_I_F_F_S_e_t_F_i_e_l_d except that it
  29.      takes a pointer to a variable argument list.  _T_I_F_F_V_S_e_t_F_i_e_l_d is useful for
  30.      writing routines that are layered on top of the functionality provided by
  31.      _T_I_F_F_S_e_t_F_i_e_l_d.
  32.  
  33.      The tags understood by _l_i_b_t_i_f_f, the number of parameter values, and the
  34.      expected types for the parameter values are shown below.  The data types
  35.      are:  _c_h_a_r* is null-terminated string and corresponds to the ASCII data
  36.      type; _u_i_n_t_1_6 is an unsigned 16-bit value; _u_i_n_t_3_2 is an unsigned 32-bit
  37.      value; _u_i_n_t_1_6* is an array of unsigned 16-bit values.  _v_o_i_d* is an array
  38.      of data values of unspecified type.
  39.  
  40.      Consult the TIFF specification for information on the meaning of each
  41.      tag.
  42.  
  43.      _T_a_g _N_a_m_e                        _C_o_u_n_t  _T_y_p_e_s              _N_o_t_e_s
  44.      TIFFTAG_ARTIST                  1      char*
  45.      TIFFTAG_BADFAXLINES             1      uint32
  46.      TIFFTAG_BITSPERSAMPLE           1      uint16             |-
  47.      TIFFTAG_CLEANFAXDATA            1      uint16
  48.      TIFFTAG_COLORMAP                3      uint16*            1<<BitsPerSample arrays
  49.      TIFFTAG_COMPRESSION             1      uint16             |-
  50.      TIFFTAG_CONSECUTIVEBADFAXLINES  1      uint32
  51.      TIFFTAG_DATETIME                1      char*
  52.      TIFFTAG_DOCUMENTNAME            1      char*
  53.      TIFFTAG_DOTRANGE                2      uint16
  54.      TIFFTAG_EXTRASAMPLES            2      uint16,uint16*     |- count & types array
  55.      TIFFTAG_FAXMODE                 1      int                |- G3/G4 compression pseudo-tag
  56.      TIFFTAG_FAXFILLFUNC             1      TIFFFaxFillFunc    G3/G4 compression pseudo-tag
  57.      TIFFTAG_FILLORDER               1      uint16             |-
  58.      TIFFTAG_GROUP3OPTIONS           1      uint32             |-
  59.      TIFFTAG_GROUP4OPTIONS           1      uint32             |-
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. TTTTIIIIFFFFFFFFSSSSeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   TTTTIIIIFFFFFFFFSSSSeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))
  70.  
  71.  
  72.  
  73.      TIFFTAG_HALFTONEHINTS           2      uint16
  74.      TIFFTAG_HOSTCOMPUTER            1      char*
  75.      TIFFTAG_IMAGEDESCRIPTION        1      char*
  76.      TIFFTAG_IMAGEDEPTH              1      uint32             |-
  77.      TIFFTAG_IMAGELENGTH             1      uint32
  78.      TIFFTAG_IMAGEWIDTH              1      uint32             |-
  79.      TIFFTAG_INKNAMES                1      char*
  80.      TIFFTAG_INKSET                  1      uint16             |-
  81.      TIFFTAG_JPEGTABLES              2      uint32*,void*      |- count & tables
  82.      TIFFTAG_JPEGQUALITY             1      int                JPEG pseudo-tag
  83.      TIFFTAG_JPEGCOLORMODE           1      int                |- JPEG pseudo-tag
  84.      TIFFTAG_JPEGTABLESMODE          1      int                |- JPEG pseudo-tag
  85.      TIFFTAG_MAKE                    1      char*
  86.      TIFFTAG_MATTEING                1      uint16             |-
  87.      TIFFTAG_MAXSAMPLEVALUE          1      uint16
  88.      TIFFTAG_MINSAMPLEVALUE          1      uint16
  89.      TIFFTAG_MODEL                   1      char*
  90.      TIFFTAG_ORIENTATION             1      uint16
  91.      TIFFTAG_PAGENAME                1      char*
  92.      TIFFTAG_PAGENUMBER              2      uint16
  93.      TIFFTAG_PHOTOMETRIC             1      uint16
  94.      TIFFTAG_PLANARCONFIG            1      uint16             |-
  95.      TIFFTAG_PREDICTOR               1      uint16             |-
  96.      TIFFTAG_PRIMARYCHROMATICITIES   1      float              6-entry array
  97.      TIFFTAG_REFERENCEBLACKWHITE     1      float*             |- 2*SamplesPerPixel array
  98.      TIFFTAG_RESOLUTIONUNIT          1      uint16
  99.      TIFFTAG_ROWSPERSTRIP            1      uint32             |- must be > 0
  100.      TIFFTAG_SAMPLEFORMAT            1      uint16             |-
  101.      TIFFTAG_SAMPLESPERPIXEL         1      uint16             |- value must be <= 4
  102.      TIFFTAG_SMAXSAMPLEVALUE         1      double
  103.      TIFFTAG_SMINSAMPLEVALUE         1      double
  104.      TIFFTAG_SOFTWARE                1      char*
  105.      TIFFTAG_SUBFILETYPE             1      uint32
  106.      TIFFTAG_SUBIFD                  2      uint16,uint32*     count & offsets array
  107.      TIFFTAG_TARGETPRINTER           1      char*
  108.      TIFFTAG_THRESHHOLDING           1      uint16
  109.      TIFFTAG_TILEDEPTH               1      uint32             |-
  110.      TIFFTAG_TILELENGTH              1      uint32             |- must be a multiple of 8
  111.      TIFFTAG_TILEWIDTH               1      uint32             |- must be a multiple of 8
  112.      TIFFTAG_TRANSFERFUNCTION        1 or 3 |=                  uint16*1<<BitsPerSample entry arrays
  113.      TIFFTAG_XPOSITION               1      float
  114.      TIFFTAG_XRESOLUTION             1      float
  115.      TIFFTAG_WHITEPOINT              1      float              2-entry array
  116.      TIFFTAG_YCBCRCOEFFICIENTS       1      float*             |- 3-entry array
  117.      TIFFTAG_YCBCRPOSITIONING        1      uint16             |-
  118.      TIFFTAG_YCBCRSAMPLING           2      uint16             |-
  119.      TIFFTAG_YPOSITION               1      float
  120.      TIFFTAG_YRESOLUTION             1      float
  121.      TIFFTAG_ICCPROFILE              2      uint32,void*       count, profile data*
  122.      |- Tag may not have its values changed once data is written.
  123.      |= If _S_a_m_p_l_e_s_P_e_r_P_i_x_e_l is one, then a single array is passed; otherwise
  124.      three arrays should be passed.
  125.  
  126.  
  127.                                                                         PPPPaaaaggggeeee 2222
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134. TTTTIIIIFFFFFFFFSSSSeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   TTTTIIIIFFFFFFFFSSSSeeeettttFFFFiiiieeeelllldddd((((3333TTTT))))
  135.  
  136.  
  137.  
  138.      * The contents of this field are quite complex.  See _T_h_e _I_C_C _P_r_o_f_i_l_e
  139.      _F_o_r_m_a_t _S_p_e_c_i_f_i_c_a_t_i_o_n, Annex B.3 "Embedding ICC Profiles in TIFF Files"
  140.      (available at http://www.color.org) for an explanation.
  141.  
  142. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  143.      1 is returned if the tag is defined in the current directory; otherwise a
  144.      0 is returned.
  145.  
  146. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  147.      1 is returned if the operation was successful.  Otherwise, 0 is returned
  148.      if an error was detected.
  149.  
  150. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  151.      All error messages are directed to the _T_I_F_F_E_r_r_o_r(3T) routine.
  152.  
  153.      %%%%ssss:::: CCCCaaaannnnnnnnooootttt mmmmooooddddiiiiffffyyyy ttttaaaagggg """"%%%%ssss"""" wwwwhhhhiiiilllleeee wwwwrrrriiiittttiiiinnnngggg.  Data has already been written
  154.      to the file, so the specified tag's value can not be changed.  This
  155.      restriction is applied to all tags that affect the format of written
  156.      data.
  157.  
  158.      %%%%dddd:::: BBBBaaaadddd vvvvaaaalllluuuueeee ffffoooorrrr """"%%%%ssss"""".  An invalid value was supplied for the named tag.
  159.  
  160. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  161.      _l_i_b_t_i_f_f(3T), _T_I_F_F_O_p_e_n(3T), _T_I_F_F_G_e_t_F_i_e_l_d(3T), _T_I_F_F_S_e_t_D_i_r_e_c_t_o_r_y(3T),
  162.      _T_I_F_F_W_r_i_t_e_D_i_r_e_c_t_o_r_y(3T), _T_I_F_F_R_e_a_d_D_i_r_e_c_t_o_r_y(3T)
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.                                                                         PPPPaaaaggggeeee 3333
  194.  
  195.  
  196.  
  197.